<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: ListFieldChangeListener.html 409 2014-08-18 16:46:48Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.core;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import java.util.NavigableSet;<a name="line.10"></a>
<span class="sourceLineNo">011</span><a name="line.11"></a>
<span class="sourceLineNo">012</span>/**<a name="line.12"></a>
<span class="sourceLineNo">013</span> * Listener interface for notifications of a change in value of a {@link ListField}.<a name="line.13"></a>
<span class="sourceLineNo">014</span> *<a name="line.14"></a>
<span class="sourceLineNo">015</span> * @see Transaction#addListFieldChangeListener Transaction.addListFieldChangeListener()<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>public interface ListFieldChangeListener {<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>    /**<a name="line.19"></a>
<span class="sourceLineNo">020</span>     * Receive notification of the addition (or insertion) of an element to a {@link ListField}.<a name="line.20"></a>
<span class="sourceLineNo">021</span>     *<a name="line.21"></a>
<span class="sourceLineNo">022</span>     * &lt;p&gt;<a name="line.22"></a>
<span class="sourceLineNo">023</span>     * Notifications are only delivered when {@code referrers} is non-empty.<a name="line.23"></a>
<span class="sourceLineNo">024</span>     * &lt;/p&gt;<a name="line.24"></a>
<span class="sourceLineNo">025</span>     *<a name="line.25"></a>
<span class="sourceLineNo">026</span>     * &lt;p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span>     * Notifications are delivered in the same thread that made the change, before the outermost mutation operation returns.<a name="line.27"></a>
<span class="sourceLineNo">028</span>     * &lt;/p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span>     *<a name="line.29"></a>
<span class="sourceLineNo">030</span>     * @param tx associated transaction<a name="line.30"></a>
<span class="sourceLineNo">031</span>     * @param id the ID of the affected object (i.e., the object containing the field that changed)<a name="line.31"></a>
<span class="sourceLineNo">032</span>     * @param field the field that changed<a name="line.32"></a>
<span class="sourceLineNo">033</span>     * @param path path of reference fields (represented by storage IDs) that lead to {@code id}<a name="line.33"></a>
<span class="sourceLineNo">034</span>     * @param referrers all objects that (indirectly) refer to the affected object via {@code path}<a name="line.34"></a>
<span class="sourceLineNo">035</span>     * @param index the position in the list at which {@code value} was added or inserted<a name="line.35"></a>
<span class="sourceLineNo">036</span>     * @param value the value added to the list<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * @param &lt;E&gt; Java type for {@code field}'s elements<a name="line.37"></a>
<span class="sourceLineNo">038</span>     */<a name="line.38"></a>
<span class="sourceLineNo">039</span>    &lt;E&gt; void onListFieldAdd(Transaction tx, ObjId id, ListField&lt;E&gt; field,<a name="line.39"></a>
<span class="sourceLineNo">040</span>      int[] path, NavigableSet&lt;ObjId&gt; referrers, int index, E value);<a name="line.40"></a>
<span class="sourceLineNo">041</span><a name="line.41"></a>
<span class="sourceLineNo">042</span>    /**<a name="line.42"></a>
<span class="sourceLineNo">043</span>     * Receive notification of a removal of an element from a {@link ListField}.<a name="line.43"></a>
<span class="sourceLineNo">044</span>     *<a name="line.44"></a>
<span class="sourceLineNo">045</span>     * &lt;p&gt;<a name="line.45"></a>
<span class="sourceLineNo">046</span>     * Notifications are only delivered when {@code referrers} is non-empty.<a name="line.46"></a>
<span class="sourceLineNo">047</span>     * &lt;/p&gt;<a name="line.47"></a>
<span class="sourceLineNo">048</span>     *<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * &lt;p&gt;<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * Notifications are delivered in the same thread that made the change, before the outermost mutation operation returns.<a name="line.50"></a>
<span class="sourceLineNo">051</span>     * &lt;/p&gt;<a name="line.51"></a>
<span class="sourceLineNo">052</span>     *<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @param tx associated transaction<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @param id the ID of the affected object (i.e., the object containing the field that changed)<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @param field the field that changed<a name="line.55"></a>
<span class="sourceLineNo">056</span>     * @param path path of reference fields (represented by storage IDs) that lead to {@code id}<a name="line.56"></a>
<span class="sourceLineNo">057</span>     * @param referrers all objects that (indirectly) refer to the affected object via {@code path}<a name="line.57"></a>
<span class="sourceLineNo">058</span>     * @param index the position in the list at which {@code value} was removed<a name="line.58"></a>
<span class="sourceLineNo">059</span>     * @param value the value removed from the list<a name="line.59"></a>
<span class="sourceLineNo">060</span>     * @param &lt;E&gt; Java type for {@code field}'s elements<a name="line.60"></a>
<span class="sourceLineNo">061</span>     */<a name="line.61"></a>
<span class="sourceLineNo">062</span>    &lt;E&gt; void onListFieldRemove(Transaction tx, ObjId id, ListField&lt;E&gt; field,<a name="line.62"></a>
<span class="sourceLineNo">063</span>      int[] path, NavigableSet&lt;ObjId&gt; referrers, int index, E value);<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>    /**<a name="line.65"></a>
<span class="sourceLineNo">066</span>     * Receive notification of the change in element at a specific position in a {@link ListField}.<a name="line.66"></a>
<span class="sourceLineNo">067</span>     *<a name="line.67"></a>
<span class="sourceLineNo">068</span>     * &lt;p&gt;<a name="line.68"></a>
<span class="sourceLineNo">069</span>     * Notifications are only delivered when {@code referrers} is non-empty.<a name="line.69"></a>
<span class="sourceLineNo">070</span>     * &lt;/p&gt;<a name="line.70"></a>
<span class="sourceLineNo">071</span>     *<a name="line.71"></a>
<span class="sourceLineNo">072</span>     * &lt;p&gt;<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * Notifications are delivered in the same thread that made the change, before the outermost mutation operation returns.<a name="line.73"></a>
<span class="sourceLineNo">074</span>     * &lt;/p&gt;<a name="line.74"></a>
<span class="sourceLineNo">075</span>     *<a name="line.75"></a>
<span class="sourceLineNo">076</span>     * @param tx associated transaction<a name="line.76"></a>
<span class="sourceLineNo">077</span>     * @param id the ID of the affected object (i.e., the object containing the field that changed)<a name="line.77"></a>
<span class="sourceLineNo">078</span>     * @param field the field that changed<a name="line.78"></a>
<span class="sourceLineNo">079</span>     * @param path path of reference fields (represented by storage IDs) that lead to {@code id}<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * @param referrers all objects that (indirectly) refer to the affected object via {@code path}<a name="line.80"></a>
<span class="sourceLineNo">081</span>     * @param index the position in the list at which the change occurred<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param oldValue the old value at list position {@code index}<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @param newValue the new value at list position {@code index}<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * @param &lt;E&gt; Java type for {@code field}'s elements<a name="line.84"></a>
<span class="sourceLineNo">085</span>     */<a name="line.85"></a>
<span class="sourceLineNo">086</span>    &lt;E&gt; void onListFieldReplace(Transaction tx, ObjId id, ListField&lt;E&gt; field,<a name="line.86"></a>
<span class="sourceLineNo">087</span>      int[] path, NavigableSet&lt;ObjId&gt; referrers, int index, E oldValue, E newValue);<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /**<a name="line.89"></a>
<span class="sourceLineNo">090</span>     * Receive notification of the clearing of a {@link ListField}.<a name="line.90"></a>
<span class="sourceLineNo">091</span>     *<a name="line.91"></a>
<span class="sourceLineNo">092</span>     * &lt;p&gt;<a name="line.92"></a>
<span class="sourceLineNo">093</span>     * This method is only used when the whole list is cleared; when a sub-range of a list is cleared, individual<a name="line.93"></a>
<span class="sourceLineNo">094</span>     * {@linkplain #onListFieldRemove onListFieldRemove()} invocations for each removed element are made instead.<a name="line.94"></a>
<span class="sourceLineNo">095</span>     * &lt;/p&gt;<a name="line.95"></a>
<span class="sourceLineNo">096</span>     *<a name="line.96"></a>
<span class="sourceLineNo">097</span>     * &lt;p&gt;<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * Notifications are only delivered when {@code referrers} is non-empty.<a name="line.98"></a>
<span class="sourceLineNo">099</span>     * &lt;/p&gt;<a name="line.99"></a>
<span class="sourceLineNo">100</span>     *<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * &lt;p&gt;<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * Notifications are delivered in the same thread that made the change, before the outermost mutation operation returns.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * &lt;/p&gt;<a name="line.103"></a>
<span class="sourceLineNo">104</span>     *<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * @param tx associated transaction<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * @param id the ID of the affected object (i.e., the object containing the field that was cleared)<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * @param field the field that changed<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @param path path of reference fields (represented by storage IDs) that lead to {@code id}<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @param referrers all objects that (indirectly) refer to the affected object via {@code path}<a name="line.109"></a>
<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
<span class="sourceLineNo">111</span>    void onListFieldClear(Transaction tx, ObjId id, ListField&lt;?&gt; field, int[] path, NavigableSet&lt;ObjId&gt; referrers);<a name="line.111"></a>
<span class="sourceLineNo">112</span>}<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>




























































</pre>
</div>
</body>
</html>
